package de.roettger_it.jmoviepilot.util;

import java.util.LinkedList;

/**
 * This class contains information about a neighbourhood of a specific movie.
 * The neighbourhood contains all movies that are similar this specific movie.
 * @author Tobias Roettger
 *
 */
public class Neighbourhood
{
	private LinkedList<Neighbour> item_neighbours;
	
	private Integer total_entries;

	/**
	 * Gets all neighbours of a movie as a list.
	 * 
	 * @return the list of neighbours.
	 */
	public LinkedList<Neighbour> getNeighbours()
	{
		return item_neighbours;
	}

	/**
	 * Sets the neighbours of a movie.
	 * 
	 * @param neighbourList the list of neighbours to set
	 */
	public void setNeighbours(LinkedList<Neighbour> neighbourList)
	{
		this.item_neighbours = neighbourList;
	}

	/**
	 * Gets the number of neighbours of a movie.
	 * 
	 * @return the number of neighbours
	 */
	public Integer getTotalEntries()
	{
		return total_entries;
	}

	/**
	 * Sets the number of neighbours of a movie.
	 * 
	 * @param totalEntries the number of neighbours of a movie
	 */
	public void setTotalEntries(int totalEntries)
	{
		this.total_entries = totalEntries;
	}
}
